<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>lacewing.client.ClientProtocol</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="lacewing-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://mp2.dk">Python Lacewing Library</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="lacewing-module.html">Package&nbsp;lacewing</a> ::
        <a href="lacewing.client-module.html">Module&nbsp;client</a> ::
        Class&nbsp;ClientProtocol
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="lacewing.client.ClientProtocol-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class ClientProtocol</h1><p class="nomargin-top"><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol">source&nbsp;code</a></span></p>
<pre class="base-tree">
twisted.internet.protocol.BaseProtocol --+        
                                         |        
        twisted.internet.protocol.Protocol --+    
                                             |    
                         <a href="lacewing.protocol.BaseProtocol-class.html">protocol.BaseProtocol</a> --+
                                                 |
                                                <strong class="uidshort">ClientProtocol</strong>
</pre>

<hr />
<p>The client protocol.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Methods</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#connectionMade" class="summary-sig-name">connectionMade</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Sends a connection acceptance request to the server after the 
      connection has been made.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.connectionMade">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#loaderReceived" class="summary-sig-name">loaderReceived</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">loader</span>,
        <span class="summary-sig-arg">isDatagram</span>=<span class="summary-sig-default">False</span>)</span><br />
      Called when a packet is received.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.loaderReceived">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#sendLoader" class="summary-sig-name">sendLoader</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">loader</span>,
        <span class="summary-sig-arg">asDatagram</span>=<span class="summary-sig-default">False</span>)</span><br />
      Sends a packetloader to the server</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.sendLoader">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#requestChannelList" class="summary-sig-name">requestChannelList</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Request a channel list from the server.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.requestChannelList">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#sendMessage" class="summary-sig-name">sendMessage</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">message</span>,
        <span class="summary-sig-arg">subchannel</span>,
        <span class="summary-sig-arg">typeName</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">asObject</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">asDatagram</span>=<span class="summary-sig-default">False</span>)</span><br />
      Send a message directly to the server.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.sendMessage">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#joinChannel" class="summary-sig-name">joinChannel</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channelName</span>,
        <span class="summary-sig-arg">hidden</span>=<span class="summary-sig-default">False</span>,
        <span class="summary-sig-arg">autoClose</span>=<span class="summary-sig-default">False</span>)</span><br />
      Join a channel by name.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.joinChannel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#leaveChannel" class="summary-sig-name">leaveChannel</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>)</span><br />
      Leave a channel.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.leaveChannel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#setName" class="summary-sig-name">setName</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Request a name change.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.setName">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="serverGreeted"></a><span class="summary-sig-name">serverGreeted</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">welcome</span>)</span><br />
      Called when the server has responded to our welcome.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.serverGreeted">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="connectionAccepted"></a><span class="summary-sig-name">connectionAccepted</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Called when the server has accepted the requested connection.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.connectionAccepted">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#loginAccepted" class="summary-sig-name">loginAccepted</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Called when the server has accepted the requested name (or has 
      specified one itself).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.loginAccepted">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#nameChanged" class="summary-sig-name">nameChanged</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">name</span>)</span><br />
      Called when the server has accepted name change (or has given the 
      client a new one).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.nameChanged">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#serverDenied" class="summary-sig-name">serverDenied</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">response</span>)</span><br />
      Called when the server disconnects or when the server denies an 
      client request.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.serverDenied">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#messageReceived" class="summary-sig-name">messageReceived</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">message</span>)</span><br />
      Called when a server message arrives.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.messageReceived">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#channelMessageReceived" class="summary-sig-name">channelMessageReceived</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>,
        <span class="summary-sig-arg">user</span>,
        <span class="summary-sig-arg">message</span>)</span><br />
      Called when a message from a channel arrives.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelMessageReceived">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#privateMessageReceived" class="summary-sig-name">privateMessageReceived</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>,
        <span class="summary-sig-arg">sender</span>,
        <span class="summary-sig-arg">message</span>)</span><br />
      Called when a private message has been received</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.privateMessageReceived">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#channelJoined" class="summary-sig-name">channelJoined</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>)</span><br />
      Called when the server has accepted a channel join request.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelJoined">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#channelLeft" class="summary-sig-name">channelLeft</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>)</span><br />
      Called when the server has accepted a channel leave request.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelLeft">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#channelUserJoined" class="summary-sig-name">channelUserJoined</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>,
        <span class="summary-sig-arg">client</span>)</span><br />
      Called when a client has joined the channel.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelUserJoined">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#channelUserExists" class="summary-sig-name">channelUserExists</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>,
        <span class="summary-sig-arg">client</span>)</span><br />
      Called when a client exists in the channel.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelUserExists">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#channelUserLeft" class="summary-sig-name">channelUserLeft</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>,
        <span class="summary-sig-arg">client</span>)</span><br />
      Called when a client has left the channel.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelUserLeft">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="lacewing.client.ClientProtocol-class.html#channelUserChanged" class="summary-sig-name">channelUserChanged</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">channel</span>,
        <span class="summary-sig-arg">client</span>)</span><br />
      Called when a client in the channel has changed name.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelUserChanged">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="pingReceived"></a><span class="summary-sig-name">pingReceived</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Called when a server ping has been received.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.pingReceived">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lacewing.protocol.BaseProtocol-class.html">protocol.BaseProtocol</a></code></b>:
      <code><a href="lacewing.protocol.BaseProtocol-class.html#dataReceived">dataReceived</a></code>,
      <code><a href="lacewing.protocol.BaseProtocol-class.html#validName">validName</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.protocol.Protocol</code></b>:
      <code>__provides__</code>,
      <code>connectionLost</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.protocol.BaseProtocol</code></b>:
      <code>__providedBy__</code>,
      <code>makeConnection</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Class Variables</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="udpTimeout"></a><span class="summary-name">udpTimeout</span> = <code title="3000">3000</code>
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lacewing.protocol.BaseProtocol-class.html">protocol.BaseProtocol</a></code></b>:
      <code><a href="lacewing.protocol.BaseProtocol-class.html#revision">revision</a></code>,
      <code><a href="lacewing.protocol.BaseProtocol-class.html#udpEnabled">udpEnabled</a></code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.protocol.Protocol</code></b>:
      <code>__implemented__</code>
      </p>
    <p class="indent-wrapped-lines"><b>Inherited from <code>twisted.internet.protocol.BaseProtocol</code></b>:
      <code>connected</code>,
      <code>transport</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== INSTANCE VARIABLES ==================== -->
<a name="section-InstanceVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Instance Variables</span></td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="datagram"></a><span class="summary-name">datagram</span> = <code title="None">None</code><br />
      The ClientDatagram protocol this connection is using for UDP handling
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="lacewing.protocol.BaseProtocol-class.html">protocol.BaseProtocol</a></code></b>:
      <code><a href="lacewing.protocol.BaseProtocol-class.html#channels">channels</a></code>,
      <code><a href="lacewing.protocol.BaseProtocol-class.html#id">id</a></code>,
      <code><a href="lacewing.protocol.BaseProtocol-class.html#isAccepted">isAccepted</a></code>,
      <code><a href="lacewing.protocol.BaseProtocol-class.html#loggedIn">loggedIn</a></code>,
      <code><a href="lacewing.protocol.BaseProtocol-class.html#name">name</a></code>,
      <code><a href="lacewing.protocol.BaseProtocol-class.html#privateAllowed">privateAllowed</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td align="left" colspan="2" class="table-header">
    <span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="connectionMade"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">connectionMade</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.connectionMade">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sends a connection acceptance request to the server after the 
  connection has been made.</p>
  <dl class="fields">
    <dt>Overrides:
        twisted.internet.protocol.BaseProtocol.connectionMade
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="loaderReceived"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">loaderReceived</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">loader</span>,
        <span class="sig-arg">isDatagram</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.loaderReceived">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when a packet is received.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>isDatagram</code></strong> - True if the message recieved was sent using UDP.</li>
    </ul></dd>
    <dt>Overrides:
        <a href="lacewing.protocol.BaseProtocol-class.html#loaderReceived">protocol.BaseProtocol.loaderReceived</a>
        <dd><em class="note">(inherited documentation)</em></dd>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="sendLoader"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">sendLoader</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">loader</span>,
        <span class="sig-arg">asDatagram</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.sendLoader">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sends a packetloader to the server</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>loader</code></strong> - The packetloader to send.</li>
    </ul></dd>
    <dt>Overrides:
        <a href="lacewing.protocol.BaseProtocol-class.html#sendLoader">protocol.BaseProtocol.sendLoader</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="requestChannelList"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">requestChannelList</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.requestChannelList">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Request a channel list from the server.</p>
  <dl class="fields">
    <dt>Returns:</dt>
        <dd>A deferred that will fire with a list of ChannelList objects</dd>
  </dl>
</td></tr></table>
</div>
<a name="sendMessage"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">sendMessage</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">message</span>,
        <span class="sig-arg">subchannel</span>,
        <span class="sig-arg">typeName</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">asObject</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">asDatagram</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.sendMessage">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Send a message directly to the server.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>message</code></strong> (str/number/ByteReader) - The message to send.</li>
        <li><strong class="pname"><code>subchannel</code></strong> - A subchannel in the range 0-256</li>
        <li><strong class="pname"><code>typeName</code></strong> - If not specified, the type will be automatically detected (see <a
          href="lacewing.packetloaders.common-module.html#DATA_TYPES" 
          class="link">lacewing.packetloaders.common.DATA_TYPES</a> for 
          possible values)</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="joinChannel"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">joinChannel</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channelName</span>,
        <span class="sig-arg">hidden</span>=<span class="sig-default">False</span>,
        <span class="sig-arg">autoClose</span>=<span class="sig-default">False</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.joinChannel">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Join a channel by name.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>hidden</code></strong> - If this connection is creating the channel, this will hide the 
          channel from channel listing</li>
        <li><strong class="pname"><code>autoClose</code></strong> - If this connection is creating the channel and if master rights 
          are enabled on the server, this will close the channel when the 
          client leaves</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="leaveChannel"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">leaveChannel</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channel</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.leaveChannel">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Leave a channel.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>channel</code></strong> (str, number, or OChannel object) - The channel to leave.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="setName"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">setName</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.setName">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Request a name change.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>name</code></strong> (str) - The name to request.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="loginAccepted"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">loginAccepted</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.loginAccepted">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when the server has accepted the requested name (or has 
  specified one itself).</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>name</code></strong> (str object) - The name of the client.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="nameChanged"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">nameChanged</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">name</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.nameChanged">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when the server has accepted name change (or has given the 
  client a new one).</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>name</code></strong> (str) - The new name for the client.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="serverDenied"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">serverDenied</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">response</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.serverDenied">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when the server disconnects or when the server denies an client
  request.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>response</code></strong> - The response of the action.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="messageReceived"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">messageReceived</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">message</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.messageReceived">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when a server message arrives.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>message</code></strong> (<a 
          href="lacewing.packetloaders.server.BinaryServerMessage-class.html"
          class="link">server.BinaryServerMessage</a> or <a 
          href="lacewing.packetloaders.server.ObjectServerMessage-class.html"
          class="link">server.ObjectServerMessage</a>)</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="channelMessageReceived"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">channelMessageReceived</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channel</span>,
        <span class="sig-arg">user</span>,
        <span class="sig-arg">message</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelMessageReceived">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when a message from a channel arrives.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>channel</code></strong> - the channel the message came from.</li>
        <li><strong class="pname"><code>user</code></strong> - the sender of the message.</li>
        <li><strong class="pname"><code>message</code></strong> (<a 
          href="lacewing.packetloaders.server.BinaryChannelMessage-class.html"
          class="link">server.BinaryChannelMessage</a> or <a 
          href="lacewing.packetloaders.server.ObjectChannelMessage-class.html"
          class="link">server.ObjectChannelMessage</a>)</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="privateMessageReceived"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">privateMessageReceived</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channel</span>,
        <span class="sig-arg">sender</span>,
        <span class="sig-arg">message</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.privateMessageReceived">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when a private message has been received</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>channel</code></strong> - the channel the user is sending from.</li>
        <li><strong class="pname"><code>message</code></strong> (<a 
          href="lacewing.packetloaders.server.BinaryChannelMessage-class.html"
          class="link">server.BinaryChannelMessage</a> or <a 
          href="lacewing.packetloaders.server.ObjectChannelMessage-class.html"
          class="link">server.ObjectChannelMessage</a>)</li>
        <li><strong class="pname"><code>sender</code></strong> (<a href="lacewing.client.Peer-class.html" class="link">Peer</a> 
          object)</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="channelJoined"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">channelJoined</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channel</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelJoined">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when the server has accepted a channel join request.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>channel</code></strong> - The channel the client has joined.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="channelLeft"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">channelLeft</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channel</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelLeft">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when the server has accepted a channel leave request.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>channel</code></strong> - The channel the client has left.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="channelUserJoined"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">channelUserJoined</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channel</span>,
        <span class="sig-arg">client</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelUserJoined">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when a client has joined the channel.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>channel</code></strong> - The channel the client has joined.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="channelUserExists"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">channelUserExists</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channel</span>,
        <span class="sig-arg">client</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelUserExists">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when a client exists in the channel.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>channel</code></strong> - The channel the client exists in.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="channelUserLeft"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">channelUserLeft</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channel</span>,
        <span class="sig-arg">client</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelUserLeft">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when a client has left the channel.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>channel</code></strong> - The channel the client has left.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<a name="channelUserChanged"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">channelUserChanged</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">channel</span>,
        <span class="sig-arg">client</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="lacewing.client-pysrc.html#ClientProtocol.channelUserChanged">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Called when a client in the channel has changed name.</p>
  <dl class="fields">
    <dt>Parameters:</dt>
    <dd><ul class="nomargin-top">
        <li><strong class="pname"><code>channel</code></strong> - The channel the client resides in.</li>
    </ul></dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="lacewing-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://mp2.dk">Python Lacewing Library</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Thu Dec 22 06:19:59 2011
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
